ListDocuments
Overview
The ListDocuments operation retrieves the entire universe of documents within the package or phase.
This operation is used to obtain a list of the documents available in a given package (or LOB phase). The request takes a package identifier (PackageID as a string) or LOB phase (LOBPhase object) and returns an array containing a document set objects for the given package or LOB phase and organization combination. To specify the organization to be used for precedence in the returned documents, you may also submit an organization object on the request. Also, you can submit the OPPSA object on the request to include in the response OPPSA-specific documents.
| Operation | ListDocuments |
|---|---|
| Style | document |
| Operation | Request-response. The endpoint receives a message, and sends a correlated message. |
| SOAP Action | http://www.wolterskluwerfs.com/2014/05/DocServices/V2/IEDocService/ListDocuments |
| Input | ListDocuments_InputMessage (soap:body, use = literal) parameterstype ListDocumentsRequest |
| Output | ListDocuments_OutputMessage (soap:body, use = literal) parameters type ListDocumentsResponse |
Request Message
The operation input is ListDocumentsRequest. The request requires a ListDocumentsRequest object containing a account identifier and content identifier as a parameter on the input.
| Parameter | Type | Constraints | Description |
|---|---|---|---|
| request | ListDocumentsRequest | Optional | The input message for the ListDocuments operation |
Response Element
The ListDocumentsResponse object contains request status information based on the ListDocumentsResult returned in the response message.
| Element | Type | Description |
|---|---|---|
| ListDocumentsResponse | ListDocumentsResponse | The output message for the ListDocuments operation used to return the list of documents. |
Request and Response Samples
For sample code, see: ListDocuments.